feat!: destructured constructor #22
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pwmcintyre
commented
May 19, 2023
Comment on lines
+48
to
+50
| constructor(params: Parameters) { | ||
| this.options = { ...DefaultOptions, ...params } | ||
| } |
There was a problem hiding this comment.
this could optionally be a non-breaking change by checking the parameter type ... but it gets pretty ugly, i'd rather break the API 🤔
Suggested change
| constructor(params: Parameters) { | |
| this.options = { ...DefaultOptions, ...params } | |
| } | |
| constructor( | |
| params?: LogLevel | Options, | |
| write?: Writer, | |
| serialize?: Serializer, | |
| stamps?: Stamper[], | |
| ) { | |
| if ( params === undefined ) { | |
| this.options = { ...DefaultOptions } | |
| } else if ( params === undefined && params as LogLevel in LogLevel ) { | |
| this.options = { ...DefaultOptions } | |
| this.options.level = params as LogLevel | |
| this.options.write = write ? write : DefaultOptions.write | |
| this.options.serialize = serialize ? serialize : DefaultOptions.serialize | |
| this.options.stamps = stamps ? stamps : DefaultOptions.stamps | |
| } else { | |
| this.options = { ...DefaultOptions, ...params as Options } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This proposal destructures the Logger constructor so that you don't have to supply all parameters, and the order doesn't matter.
For example, if you want to supply a custom
Stamper...Previous
Since it is currently the last of the optional parameters, you need to supply all the other parameters, there is no option to leave them blank or as default:
Proposed
Now you can omit parameters you want to leave as defaults: